Skip to content

MkTable

Show source on GitHub

Class representing a formatted table.

Example: Regular

Jinja

{{ {"Column A": ["A", "B", "C"], "Column B": ["C", "D", "E"]} | MkTable }}

Python

MkTable(data={'Column A': ['A', 'B', 'C'], 'Column B': ['C', 'D', 'E']})
Column A Column B
A C
B D
C E 
| Column A | Column B |
| -------- | -------- |
| A        | C        |
| B        | D        |
| C        | E        |

<table>
<thead>
<tr>
<th>Column A</th>
<th>Column B</th>
</tr>
</thead>
<tbody>
<tr>
<td>A</td>
<td>C</td>
</tr>
<tr>
<td>B</td>
<td>D</td>
</tr>
<tr>
<td>C</td>
<td>E</td>
</tr>
</tbody>
</table>

MkTable
├── MkText('A')
├── MkText('B')
├── MkText('C')
├── MkText('C')
├── MkText('D')
╰── MkText('E')

Bases: MkBaseTable

Name Children Inherits
MkBaseTable
mknodes.basenodes.mkbasetable
Base Class for MkTables. Only deals with managing the data.		 
graph TD
  94420314289568["mktable.MkTable"]
  94420314009072["mkbasetable.MkBaseTable"]
  94420312299136["mkcontainer.MkContainer"]
  94420313076768["mknode.MkNode"]
  94420313236736["node.Node"]
  140608527347936["builtins.object"]
  94420314009072 --> 94420314289568
  94420312299136 --> 94420314009072
  94420313076768 --> 94420312299136
  94420313236736 --> 94420313076768
  140608527347936 --> 94420313236736
/home/runner/work/mknodes/mknodes/mknodes/basenodes/mktable/metadata.toml
[metadata]
icon = "octicon:table-24"
name = "MkTable"

[requirements.extension.tables]

[examples.regular]
title = "Regular"
jinja = """
{{ {"Column A": ["A", "B", "C"], "Column B": ["C", "D", "E"]} | MkTable }}
"""

[example.list_of_dicts]
title = "From list of dicts"
jinja = """
{{ [{"col 1": "abc", "col 2": "cde"}, {"col 1": "fgh", "col 2": "ijk"}] | MkTable }}
"""

# [output.markdown]
# template = """
# {% for k in table_data.keys() %}
# {% endfor %}
# {% for row in self.iter_rows() %}
# {% endfor %}

# """
mknodes.basenodes.mktable.MkTable
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class MkTable(mkbasetable.MkBaseTable):
    """Class representing a formatted table."""

    REQUIRED_EXTENSIONS = [resources.Extension("tables")]

    def _to_markdown(self) -> str:
        table_data = self.data  # property
        if not any(table_data[k] for k in table_data):
            return ""
        widths = [self.width_for_column(c) for c in table_data]
        formatters = [f"{{:<{width}}}" for width in widths]
        headers = [formatters[i].format(k) for i, k in enumerate(table_data.keys())]
        divider = [width * "-" for width in widths]
        data = [
            [
                formatters[i].format(str(k).replace("\n", "<br>"))
                for i, k in enumerate(row)
            ]
            for row in self.iter_rows()
        ]
        header_txt = "| " + " | ".join(headers) + " |"
        divider_text = "| " + " | ".join(divider) + " |"
        data_txt = ["| " + " | ".join(line) + " |" for line in data]
        return "\n".join([header_txt, divider_text, *data_txt]) + "\n"